VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
Related Functions
vive_3dsp_ambisonic_decoder Struct Reference

The vive_3dsp_ambi_decoder structure represents the ambisonic decoder. More...

#include <vive_3dsp_api/ambisonic_decoder.h>

Related Functions

(Note that these are not member functions.)

vive_3dsp_ambisonic_decoder * vive_3dsp_ambi_decoder_create_object (vive_3dsp_context *api, int sampleRate)
 
VIVE_3DSP_API_STATUS vive_3dsp_ambi_decoder_destroy_object (vive_3dsp_context *api, vive_3dsp_ambisonic_decoder *coder)
 
VIVE_3DSP_API_STATUS vive_3dsp_ambi_decoder_process (vive_3dsp_context *api, vive_3dsp_ambisonic_decoder *coder, float *in_buffer, float *out_buffer, int sampleLength)
 

Detailed Description

The vive_3dsp_ambi_decoder structure represents the ambisonic decoder.

Friends And Related Function Documentation

◆ vive_3dsp_ambi_decoder_create_object()

vive_3dsp_ambisonic_decoder * vive_3dsp_ambi_decoder_create_object ( vive_3dsp_context *  api,
int  sampleRate 
)
related

Create an ambisonic decoder.

Parameters
apiThe audio engine object.
sampleRateThe sample rate of the AmbiX audio clip.
Returns
The ambisonic decoder object.

◆ vive_3dsp_ambi_decoder_destroy_object()

VIVE_3DSP_API_STATUS vive_3dsp_ambi_decoder_destroy_object ( vive_3dsp_context *  api,
vive_3dsp_ambisonic_decoder *  coder 
)
related

Destroy an ambisonic decoder.

Parameters
apiThe audio engine object.
coderThe ambisonic decoder object.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_ambi_decoder_process()

VIVE_3DSP_API_STATUS vive_3dsp_ambi_decoder_process ( vive_3dsp_context *  api,
vive_3dsp_ambisonic_decoder *  coder,
float *  in_buffer,
float *  out_buffer,
int  sampleLength 
)
related

Process and decode the AmbiX format audio frames into stereo frames.

Parameters
apiThe audio engine object.
coderThe ambisonic decoder object.
in_bufferInput buffer.
out_bufferOutput buffer.
sampleLengthNumber of samples.
Returns
Status code indicating whether or not the operation succeeded.

The documentation for this struct was generated from the following file: